

<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
  "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">


<html xmlns="http://www.w3.org/1999/xhtml">
  <head>
    <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
    
    <title>scitools.modulecheck &mdash; SciTools 0.8.3 documentation</title>
    
    <link rel="stylesheet" href="_static/default.css" type="text/css" />
    <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    
    <script type="text/javascript">
      var DOCUMENTATION_OPTIONS = {
        URL_ROOT:    '',
        VERSION:     '0.8.3',
        COLLAPSE_INDEX: false,
        FILE_SUFFIX: '.html',
        HAS_SOURCE:  true
      };
    </script>
    <script type="text/javascript" src="_static/jquery.js"></script>
    <script type="text/javascript" src="_static/underscore.js"></script>
    <script type="text/javascript" src="_static/doctools.js"></script>
    <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
    <link rel="top" title="SciTools 0.8.3 documentation" href="index.html" />
    <link rel="next" title="scitools.MovingPlotWindow" href="MovingPlotWindow.html" /> 
  </head>
  <body>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             accesskey="I">index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="np-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="MovingPlotWindow.html" title="scitools.MovingPlotWindow"
             accesskey="N">next</a> |</li>
        <li><a href="index.html">SciTools 0.8.3 documentation</a> &raquo;</li> 
      </ul>
    </div>  

    <div class="document">
      <div class="documentwrapper">
        <div class="bodywrapper">
          <div class="body">
            
  <div class="section" id="module-scitools.modulecheck">
<span id="scitools-modulecheck"></span><h1><a class="reference internal" href="#module-scitools.modulecheck" title="scitools.modulecheck"><tt class="xref py py-mod docutils literal"><span class="pre">scitools.modulecheck</span></tt></a><a class="headerlink" href="#module-scitools.modulecheck" title="Permalink to this headline">¶</a></h1>
<p>Import a set of modules. If modules are missing,
one can get these as a comma-separated string, or
one can raise exceptions.</p>
<p>See test block for demo of how this module can be used.</p>
<dl class="function">
<dt id="scitools.modulecheck.PmwBlt">
<tt class="descclassname">scitools.modulecheck.</tt><tt class="descname">PmwBlt</tt><big>(</big><em>verbose=0</em><big>)</big><a class="reference internal" href="_modules/scitools/modulecheck.html#PmwBlt"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#scitools.modulecheck.PmwBlt" title="Permalink to this definition">¶</a></dt>
<dd></dd></dl>

<dl class="function">
<dt id="scitools.modulecheck.exception">
<tt class="descclassname">scitools.modulecheck.</tt><tt class="descname">exception</tt><big>(</big><em>msg</em>, <em>*module_names</em><big>)</big><a class="reference internal" href="_modules/scitools/modulecheck.html#exception"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#scitools.modulecheck.exception" title="Permalink to this definition">¶</a></dt>
<dd><p>Raise an ImportError exception if modules
are missing. Print the names of the missing modules.</p>
</dd></dl>

<dl class="function">
<dt id="scitools.modulecheck.message">
<tt class="descclassname">scitools.modulecheck.</tt><tt class="descname">message</tt><big>(</big><em>module</em>, <em>critical=1</em>, <em>msg=None</em><big>)</big><a class="reference internal" href="_modules/scitools/modulecheck.html#message"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#scitools.modulecheck.message" title="Permalink to this definition">¶</a></dt>
<dd><p>Import a module and write a message if it is missing.
critical=0 means that the module is not critical
(programs may work without). critical=1 means that the
module must be installed.
msg is an optional description of the module.</p>
</dd></dl>

<dl class="function">
<dt id="scitools.modulecheck.missing">
<tt class="descclassname">scitools.modulecheck.</tt><tt class="descname">missing</tt><big>(</big><em>*module_names</em><big>)</big><a class="reference internal" href="_modules/scitools/modulecheck.html#missing"><span class="viewcode-link">[source]</span></a><a class="headerlink" href="#scitools.modulecheck.missing" title="Permalink to this definition">¶</a></dt>
<dd><p>Check if modules can be imported.
Return a string containing the missing modules.</p>
</dd></dl>

</div>


          </div>
        </div>
      </div>
      <div class="sphinxsidebar">
        <div class="sphinxsidebarwrapper">
            <p class="logo"><a href="index.html">
              <img class="logo" src="_static/scitools_logo.jpg" alt="Logo"/>
            </a></p>
  <h4>Next topic</h4>
  <p class="topless"><a href="MovingPlotWindow.html"
                        title="next chapter"><tt class="docutils literal docutils literal"><span class="pre">scitools.MovingPlotWindow</span></tt></a></p>
  <h3>This Page</h3>
  <ul class="this-page-menu">
    <li><a href="_sources/modulecheck.txt"
           rel="nofollow">Show Source</a></li>
  </ul>
<div id="searchbox" style="display: none">
  <h3>Quick search</h3>
    <form class="search" action="search.html" method="get">
      <input type="text" name="q" />
      <input type="submit" value="Go" />
      <input type="hidden" name="check_keywords" value="yes" />
      <input type="hidden" name="area" value="default" />
    </form>
    <p class="searchtip" style="font-size: 90%">
    Enter search terms or a module, class or function name.
    </p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
        </div>
      </div>
      <div class="clearer"></div>
    </div>
    <div class="related">
      <h3>Navigation</h3>
      <ul>
        <li class="right" style="margin-right: 10px">
          <a href="genindex.html" title="General Index"
             >index</a></li>
        <li class="right" >
          <a href="py-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="np-modindex.html" title="Python Module Index"
             >modules</a> |</li>
        <li class="right" >
          <a href="MovingPlotWindow.html" title="scitools.MovingPlotWindow"
             >next</a> |</li>
        <li><a href="index.html">SciTools 0.8.3 documentation</a> &raquo;</li> 
      </ul>
    </div>
    <div class="footer">
        &copy; Copyright 2012, H. P. Langtangen, J. Ring, ++.
      Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.2.
    </div>
  </body>
</html>